Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

docs(contributing): add Contributing TL;DR page #1484

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Lee-W merged 2 commits into commitizen-tools:master from bearomorphism:doc-contributing
Jun 8, 2025

Conversation

Copy link
Contributor

@bearomorphism bearomorphism commented May 31, 2025 •
edited
Loading

Description

I believe the new page makes it easier for developers to understand how to contribute effectively.

Checklist

Documentation Changes

  • Run poetry doc locally to ensure the documentation pages renders correctly
    • Check if there are any broken links in the documentation

When running poetry doc, any broken internal documentation links will be reported in the console output like this:

INFO - Doc file 'config.md' contains a link 'commands/bump.md#-post_bump_hooks', but the doc 'commands/bump.md' does not contain an anchor '#-post_bump_hooks'.

Copy link

codecov bot commented May 31, 2025 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.62%. Comparing base (120d514) to head (f274846).
Report is 660 commits behind head on master.

Additional details and impacted files 
@@ Coverage Diff @@
## master #1484 +/- ##
==========================================
+ Coverage 97.33% 97.62% +0.28% 
==========================================
 Files 42 57 +15 
 Lines 2104 2653 +549 
==========================================
+ Hits 2048 2590 +542 
- Misses 56 63 +7
Flag Coverage Δ
unittests 97.62% <ø> (+0.28%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@bearomorphism bearomorphism force-pushed the doc-contributing branch 2 times, most recently from c3560c5 to dfcaf93 Compare May 31, 2025 14:55
Copy link
Member

@Lee-W Lee-W left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I love it! but would like to keep it for a few days so that others can check whether this new page works good 🙂

bearomorphism reacted with heart emoji
@Lee-W Lee-W added pr-status: ready-to-merge almost ready to merge. just keep it for a few days for others to check and removed pr-status: wait-for-review labels Jun 1, 2025
@Lee-W Lee-W merged commit 195ed16 into commitizen-tools:master Jun 8, 2025
18 checks passed
@bearomorphism bearomorphism deleted the doc-contributing branch June 12, 2025 16:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Lee-W Lee-W Lee-W approved these changes

@woile woile Awaiting requested review from woile woile is a code owner

@noirbizarre noirbizarre Awaiting requested review from noirbizarre noirbizarre is a code owner

Assignees
No one assigned
Labels
pr-status: ready-to-merge almost ready to merge. just keep it for a few days for others to check type: documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

AltStyle によって変換されたページ (->オリジナル) /